Carbon


DrawThemeFocusRegion

Header: Appearance.h Carbon status: Supported

Draws or erases a focus ring around a specified region.

OSStatus DrawThemeFocusRegion (
     inRegion, 
    Boolean inHasFocus
);
inRegion

A value of type RgnHandle. Before calling DrawThemeFocusRegion, set the region to the position around which to draw the focus ring, in local coordinates. The focus ring is drawn outside the region that is passed in, and it can be outset a maximum of 3 pixels.

inHasFocus

A value of type Boolean. Pass true to draw the focus region. Pass false to erase the focus region.

function result

A result code.

DISCUSSION

Your application can use the DrawThemeFocusRegion function to draw a theme-compliant focus ring. The presence of a focus ring indicates whether an item has keyboard focus.

VERSION NOTES

This function is available with Appearance Manager 1.0.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)